autocomplete
| query required | string query to complete |
| track | integer >= 0 Default: 0 amount of track names to complete |
| artist | integer >= 0 Default: 0 amount of artist names to complete |
| album | integer >= 0 Default: 0 amount of album names to complete |
| folder | integer >= 0 Default: 0 amount of folder names to complete |
| playlist | integer >= 0 Default: 0 amount of playlist names to complete |
| podcast | integer >= 0 Default: 0 amount of podcast names to complete |
| episode | integer >= 0 Default: 0 amount of episode names to complete |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get list of genres found in the library
| rootID | string filter by root id |
ok
parameter is missing or invalid
unauthorized
internal server error
get count stats for folders/tracks/albums/...
| rootID | string filter by root id |
ok
parameter is missing or invalid
unauthorized
internal server error
get list of tracks played by all users
ok
unauthorized
internal server error
login an user
| username required | string user name |
| password required | string password |
| client required | string client name |
ok
parameter is missing or invalid
unauthorized
internal server error
lookup lastfm data
| type required | string (JamParameters.LastFMLookupType) Enum:"album" "album-toptracks" "artist" "artist-toptracks" "track" "track-similar" lookup by lastfm type |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
lookup acoustid data
| inc | string comma-separated acoustid includes |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
lookup musicbrainz data
| type required | string (JamParameters.MusicBrainzLookupType) Enum:"area" "artist" "collection" "event" "instrument" "label" "place" "recording" "release" "release-group" "series" "url" "work" lookup by musicbrainz type |
| inc | string comma-separated musicbrainz includes |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
search musicbrainz data
| type required | string (JamParameters.MusicBrainzSearchType) Enum:"area" "artist" "label" "recording" "release" "release-group" "work" search by musicbrainz type |
| recording | string search by recording name |
| releasegroup | string search by releasegroup name |
| release | string search by release name |
| artist | string search by artist name |
| tracks | integer search by number of release tracks |
ok
parameter is missing or invalid
unauthorized
internal server error
lookup acousticbrainz data
| nr | number page parameter if more than one acousticbrainz info is available |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
lookup coverartarchive data
| type required | string (JamParameters.CoverArtArchiveLookupType) Enum:"release" "release-group" lookup by musicbrainz type |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
wikipedia summary
| title required | string lookup by page title |
| lang | string Default: "en" wikipedia language |
ok
parameter is missing or invalid
unauthorized
internal server error
wikipedia summary
| id required | string lookup by wikidata id |
| lang | string Default: "en" get summary of wikipedia language |
ok
parameter is missing or invalid
unauthorized
internal server error
get chat messages
| since | integer >= 0 filter by post time (unix time) |
ok
parameter is missing or invalid
unauthorized
internal server error
| message required | string the chat message |
ok
parameter is missing or invalid
unauthorized
internal server error
| time required | integer >= 0 time of the post (unix time) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the navigation index for folders
| rootID | string filter by root id |
ok
parameter is missing or invalid
unauthorized
internal server error
get a folder by id
| id required | string the item id |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
| folderChildren | boolean Default: false include tracks and sub folders on folder(s) |
| folderSubfolders | boolean Default: false include sub folders on folder(s) |
| folderTracks | boolean Default: false include tracks on folder(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get folders by ids
| ids required | Array of string array of item ids |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
| folderChildren | boolean Default: false include tracks and sub folders on folder(s) |
| folderSubfolders | boolean Default: false include sub folders on folder(s) |
| folderTracks | boolean Default: false include tracks on folder(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get tracks and subfolders of a folder by id
| id required | string the item id |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get tracks of a folder by id
| recursive | boolean Default: false include tracks of a sub folders |
| ids required | Array of string array of item ids |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get sub folders of a folder by id
| id required | string the item id |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get similar artist folders of a folder by id
| id required | string the item id |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
| folderChildren | boolean Default: false include tracks and sub folders on folder(s) |
| folderSubfolders | boolean Default: false include sub folders on folder(s) |
| folderTracks | boolean Default: false include tracks on folder(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get external artist description of a folder by id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get external album description of a folder by id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a list of folders by list type
| id | string filter by id |
| rootID | string filter by root id |
| parentID | string filter by parent folder id |
| childOfID | string filter if folder is in folder id (or its subfolders) |
| artist | string filter by artist name |
| title | string filter by title |
| album | string filter by album name |
| genre | string filter by genre |
| level | number filter by level |
| newerThan | integer >= 0 filter by creation date (unix time) |
| fromYear | integer >= 0 filter by year |
| toYear | integer >= 0 filter by year |
| type | string Enum:"album" "artist" "collection" "extras" "multialbum" "unknown" filter by folder type |
| types | Array of string Items Enum:"album" "artist" "collection" "extras" "multialbum" "unknown" filter by folder types |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
| list required | string (JamParameters.ListType) Enum:"avghighest" "faved" "frequent" "highest" "random" "recent" the type of the item list |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
internal server error
search folders
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| id | string filter by id |
| rootID | string filter by root id |
| parentID | string filter by parent folder id |
| childOfID | string filter if folder is in folder id (or its subfolders) |
| artist | string filter by artist name |
| title | string filter by title |
| album | string filter by album name |
| genre | string filter by genre |
| level | number filter by level |
| newerThan | integer >= 0 filter by creation date (unix time) |
| fromYear | integer >= 0 filter by year |
| toYear | integer >= 0 filter by year |
| type | string Enum:"album" "artist" "collection" "extras" "multialbum" "unknown" filter by folder type |
| types | Array of string Items Enum:"album" "artist" "collection" "extras" "multialbum" "unknown" filter by folder types |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| folderChildren | boolean Default: false include tracks and sub folders on folder(s) |
| folderSubfolders | boolean Default: false include sub folders on folder(s) |
| folderTracks | boolean Default: false include tracks on folder(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
list of folders with health issues
| id | string filter by id |
| rootID | string filter by root id |
| parentID | string filter by parent folder id |
| childOfID | string filter if folder is in folder id (or its subfolders) |
| artist | string filter by artist name |
| title | string filter by title |
| album | string filter by album name |
| genre | string filter by genre |
| level | number filter by level |
| newerThan | integer >= 0 filter by creation date (unix time) |
| fromYear | integer >= 0 filter by year |
| toYear | integer >= 0 filter by year |
| type | string Enum:"album" "artist" "collection" "extras" "multialbum" "unknown" filter by folder type |
| types | Array of string Items Enum:"album" "artist" "collection" "extras" "multialbum" "unknown" filter by folder types |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| folderTag | boolean Default: false include tag on folder(s) |
| folderState | boolean Default: false include user states (fav,rate) on folder(s) |
| folderCounts | boolean Default: false include information about children (trackCount/folderCount) on folder(s) |
| folderHealth | boolean Default: false include information about the meta data quality on folder(s) |
| folderParents | boolean Default: false include a list of all parent folder ids on folder(s) |
| folderInfo | boolean Default: false include extended meta data on folder(s) |
| folderSimilar | boolean Default: false include similar folders list on folder(s) - only for folders of type artist |
| folderArtworks | boolean Default: false include artwork images list on folder(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get the user state (fav/rating) by folder id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by folders ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get similar tracks of a/by artist folder id
| id required | string the item id |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the artwork list by folder id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download folder as binary archive
| format | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download artwork image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| url required | string url of an image |
| types required | Array of string Items Enum:"artist" "back" "booklet" "front" "liner" "medium" "obi" "other" "poster" "raw" "spine" "sticker" "track" "tray" "unedited" "watermark" types of the image |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| name required | string the new folder name |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| remove | boolean Default: false add or remove the item fav |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| rating required | integer [ 0 .. 5 ] the rating for the item |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a track by id
| id required | string the item id |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get tracks by ids
| ids required | Array of string array of item ids |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get an id3 tag by track id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get id3 tags by track ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
internal server error
search tracks
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| artist | string filter by artist name |
| artistID | string filter by artist id |
| parentID | string filter by parent folder id |
| parentIDs | Array of string filter by parent folder ids |
| childOfID | string filter if track is in folder id (or its subfolders) |
| rootID | string filter by root id |
| title | string filter by title |
| album | string filter by album |
| genre | string filter by genre |
| newerThan | integer filter by creation date |
| fromYear | integer filter by year |
| toYear | integer filter by year |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get the user state (fav/rating) by track id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by track ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a track list by track list type
| artist | string filter by artist name |
| artistID | string filter by artist id |
| parentID | string filter by parent folder id |
| parentIDs | Array of string filter by parent folder ids |
| childOfID | string filter if track is in folder id (or its subfolders) |
| rootID | string filter by root id |
| title | string filter by title |
| album | string filter by album |
| genre | string filter by genre |
| newerThan | integer filter by creation date |
| fromYear | integer filter by year |
| toYear | integer filter by year |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| list required | string (JamParameters.ListType) Enum:"avghighest" "faved" "frequent" "highest" "random" "recent" the type of the item list |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
internal server error
get the similar tracks by track id
| id required | string the item id |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download track media as binary
| maxBitRate | integer >= 10 maximal bitrate if transcoding (in Kbps) |
| format | string Default: "mp3" Value:"mp3" format of audio stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download track media as binary archive
| format | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| remove | boolean Default: false add or remove the item fav |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| rating required | integer [ 0 .. 5 ] the rating for the item |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the id of the track |
| tag required | object (Jam.ID3Tag) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| name required | string the new track file name |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a podcast episode by id
| id required | string the item id |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get podcast episodes by ids
| ids required | Array of string array of item ids |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
search podcast episodes
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| podcastID | string filter by podcast id |
| name | string filter by title |
| status | string filter by status |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
retrieve a podcast episode media file
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user state (fav/rating) by podcast episode id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by podcast episode ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the episode state (e.g. downloading, new, etc.) by podcast episode id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
get a list of episodes by list type
| podcastID | string filter by podcast id |
| name | string filter by title |
| status | string filter by status |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| list required | string (JamParameters.ListType) Enum:"avghighest" "faved" "frequent" "highest" "random" "recent" the type of the item list |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
internal server error
download episode media as binary
| maxBitRate | integer >= 10 maximal bitrate if transcoding (in Kbps) |
| format | string Default: "mp3" Value:"mp3" format of audio stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download episode media as binary archive
| format | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| remove | boolean Default: false add or remove the item fav |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| rating required | integer [ 0 .. 5 ] the rating for the item |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a podcast by id
| id required | string the item id |
| podcastState | boolean Default: false include user states (fav,rate) on podcast(s) |
| podcastEpisodes | boolean Default: false include episodes on podcast(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get podcasts by ids
| ids required | Array of string array of item ids |
| podcastState | boolean Default: false include user states (fav,rate) on podcast(s) |
| podcastEpisodes | boolean Default: false include episodes on podcast(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get the podcast state (e.g. downloading, new, etc.) by podcast id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
search podcasts
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| url | string filter by podcast url |
| title | string filter by podcast title |
| status | string filter by podcast status |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| podcastState | boolean Default: false include user states (fav,rate) on podcast(s) |
| podcastEpisodes | boolean Default: false include episodes on podcast(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
check podcast feeds for new episodes by podcast id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user state (fav/rating) by podcast id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by podcast ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a list of podcasts by list type
| url | string filter by podcast url |
| title | string filter by podcast title |
| status | string filter by podcast status |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| podcastState | boolean Default: false include user states (fav,rate) on podcast(s) |
| podcastEpisodes | boolean Default: false include episodes on podcast(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| list required | string (JamParameters.ListType) Enum:"avghighest" "faved" "frequent" "highest" "random" "recent" the type of the item list |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download podcast episodes as binary archive
| format | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| url required | string podcast feed url |
ok
parameter is missing or invalid
unauthorized
internal server error
| remove | boolean Default: false add or remove the item fav |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| rating required | integer [ 0 .. 5 ] the rating for the item |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a radio by id
| id required | string the item id |
| radioState required | boolean Default: false include user states (fav,rate) on radio(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get radios by ids
| ids required | Array of string array of item ids |
| radioState required | boolean Default: false include user states (fav,rate) on radio(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
search radios
| ids required | Array of string array of item ids |
| radioState required | boolean Default: false include user states (fav,rate) on radio(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get the user state (fav/rating) by radio id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by radio ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| name required | string radio name |
| url required | string radio stream url |
| homepage | string radio homepage url |
ok
parameter is missing or invalid
unauthorized
internal server error
| name | string radio name |
| url | string radio stream url |
| homepage | string radio homepage url |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get an artist by id
| rootID | string filter by root id |
| id required | string the item id |
| artistAlbums | boolean Default: false include albums on artist(s) |
| artistAlbumIDs | boolean Default: false include album ids on artist(s) |
| artistState | boolean Default: false include user states (fav,rate) on artist(s) |
| artistTracks | boolean Default: false include tracks on artist(s) |
| artistTracksIDs | boolean Default: false include track ids on artist(s) |
| artistInfo | boolean Default: false include extended meta data on artist(s) |
| artistSimilar | boolean Default: false include similar artists on artist(s) |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get artists by ids
| ids required | Array of string array of item ids |
| artistAlbums | boolean Default: false include albums on artist(s) |
| artistAlbumIDs | boolean Default: false include album ids on artist(s) |
| artistState | boolean Default: false include user states (fav,rate) on artist(s) |
| artistTracks | boolean Default: false include tracks on artist(s) |
| artistTracksIDs | boolean Default: false include track ids on artist(s) |
| artistInfo | boolean Default: false include extended meta data on artist(s) |
| artistSimilar | boolean Default: false include similar artists on artist(s) |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
search artists
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| name | string filter by name |
| rootID | string filter by root id |
| albumID | string filter by album id |
| mbArtistID | string filter by musicbrainz album id |
| newerThan | integer >= 0 filter by creation date (unix time) |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| artistAlbums | boolean Default: false include albums on artist(s) |
| artistAlbumIDs | boolean Default: false include album ids on artist(s) |
| artistState | boolean Default: false include user states (fav,rate) on artist(s) |
| artistTracks | boolean Default: false include tracks on artist(s) |
| artistTracksIDs | boolean Default: false include track ids on artist(s) |
| artistInfo | boolean Default: false include extended meta data on artist(s) |
| artistSimilar | boolean Default: false include similar artists on artist(s) |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get the user state (fav/rating) by artist id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by artist ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a artist list by artist list type
| name | string filter by name |
| rootID | string filter by root id |
| albumID | string filter by album id |
| mbArtistID | string filter by musicbrainz album id |
| newerThan | integer >= 0 filter by creation date (unix time) |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| artistAlbums | boolean Default: false include albums on artist(s) |
| artistAlbumIDs | boolean Default: false include album ids on artist(s) |
| artistState | boolean Default: false include user states (fav,rate) on artist(s) |
| artistTracks | boolean Default: false include tracks on artist(s) |
| artistTracksIDs | boolean Default: false include track ids on artist(s) |
| artistInfo | boolean Default: false include extended meta data on artist(s) |
| artistSimilar | boolean Default: false include similar artists on artist(s) |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| list required | string (JamParameters.ListType) Enum:"avghighest" "faved" "frequent" "highest" "random" "recent" the type of the item list |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
internal server error
get similar tracks of an artist by artist id
| id required | string the item id |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get similar artists of an artist by artist id
| rootID | string filter by root id |
| id required | string the item id |
| artistAlbums | boolean Default: false include albums on artist(s) |
| artistAlbumIDs | boolean Default: false include album ids on artist(s) |
| artistState | boolean Default: false include user states (fav,rate) on artist(s) |
| artistTracks | boolean Default: false include tracks on artist(s) |
| artistTracksIDs | boolean Default: false include track ids on artist(s) |
| artistInfo | boolean Default: false include extended meta data on artist(s) |
| artistSimilar | boolean Default: false include similar artists on artist(s) |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the navigation index for artists
| rootID | string filter by root id |
ok
parameter is missing or invalid
unauthorized
internal server error
get external artist description by id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download artist tracks as binary archive
| format | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| remove | boolean Default: false add or remove the item fav |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| rating required | integer [ 0 .. 5 ] the rating for the item |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get tracks of an artist by artist id
| ids required | Array of string array of item ids |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get an album by id
| id required | string the item id |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get albums by ids
| ids required | Array of string array of item ids |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get a artist list by album list type
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| name | string filter by name |
| rootID | string filter by root id |
| artist | string filter by artist name |
| artistID | string filter by artist id |
| trackID | string filter by track id |
| mbAlbumID | string filter by album id |
| mbArtistID | string filter by artist id |
| genre | string filter by genre |
| albumType | string Enum:"album" "audiobook" "compilation" "unknown" filter by album type |
| albumTypes | Array of string Items Enum:"album" "audiobook" "compilation" "unknown" filter by album types |
| newerThan | integer >= 0 filter by creation date (unix time) |
| fromYear | integer >= 0 filter by year |
| toYear | integer >= 0 filter by year |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| list required | string (JamParameters.ListType) Enum:"avghighest" "faved" "frequent" "highest" "random" "recent" the type of the item list |
ok
parameter is missing or invalid
unauthorized
internal server error
search albums
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| name | string filter by name |
| rootID | string filter by root id |
| artist | string filter by artist name |
| artistID | string filter by artist id |
| trackID | string filter by track id |
| mbAlbumID | string filter by album id |
| mbArtistID | string filter by artist id |
| genre | string filter by genre |
| albumType | string Enum:"album" "audiobook" "compilation" "unknown" filter by album type |
| albumTypes | Array of string Items Enum:"album" "audiobook" "compilation" "unknown" filter by album types |
| newerThan | integer >= 0 filter by creation date (unix time) |
| fromYear | integer >= 0 filter by year |
| toYear | integer >= 0 filter by year |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| albumTracks | boolean Default: false include tracks on album(s) |
| albumTrackIDs | boolean Default: false include track ids on album(s) |
| albumState | boolean Default: false include user states (fav,rate) on album(s) |
| albumInfo | boolean Default: false include extended meta data on album(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get the user state (fav/rating) by album id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by album ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get similar tracks of an artist by album id
| id required | string the item id |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get tracks of an album by album id
| ids required | Array of string array of item ids |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get external album description by id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download album tracks as binary archive
| format | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| remove | boolean Default: false add or remove the item fav |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| rating required | integer [ 0 .. 5 ] the rating for the item |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a playlist by id
| id required | string the item id |
| playlistTracks | boolean Default: false include tracks on playlist(s) |
| playlistTracksIDs | boolean Default: false include track ids on playlist(s) |
| playlistState | boolean Default: false include user states (fav,rate) on playlist(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get playlists by ids
| ids required | Array of string array of item ids |
| playlistTracks | boolean Default: false include tracks on playlist(s) |
| playlistTracksIDs | boolean Default: false include track ids on playlist(s) |
| playlistState | boolean Default: false include user states (fav,rate) on playlist(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
search playlists
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| name | string filter by playlist name |
| isPublic | boolean filter by public state |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
| playlistTracks | boolean Default: false include tracks on playlist(s) |
| playlistTracksIDs | boolean Default: false include track ids on playlist(s) |
| playlistState | boolean Default: false include user states (fav,rate) on playlist(s) |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
get the user state (fav/rating) by playlist id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get the user states (fav/rating) by playlist ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| ids required | Array of string array of item ids |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download playlist tracks as binary archive
| format | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| name required | string name of playlist |
| comment | string a comment |
| isPublic | boolean set the playlist visible for other users or not |
| trackIDs | Array of string track ids of the playlist, may include duplicates |
ok
parameter is missing or invalid
unauthorized
internal server error
| name | string name of playlist |
| comment | string a comment |
| isPublic | boolean set the playlist visible for other users or not |
| trackIDs | Array of string track ids of the playlist, may include duplicates |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| remove | boolean Default: false add or remove the item fav |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| rating required | integer [ 0 .. 5 ] the rating for the item |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get an user by id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get users by ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
internal server error
search users
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| name | string filter by user name |
| isAdmin | boolean filter by user admin role |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
ok
parameter is missing or invalid
unauthorized
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
create a new user
| name required | string name of the user |
string email of the user | |
| roleAdmin | boolean Default: false user has admin rights |
| rolePodcast | boolean Default: false user has podcast admin rights |
| roleStream | boolean Default: true user has streaming/download rights |
| roleUpload | boolean Default: false user has upload rights |
ok
parameter is missing or invalid
unauthorized
internal server error
update user
| name | string name of the user |
string email of the user | |
| roleAdmin | boolean user has admin rights |
| rolePodcast | boolean user has podcast admin rights |
| roleStream | boolean user has streaming/download rights |
| roleUpload | boolean user has upload rights |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
set a password for the user
| password required | string new password of user |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
set an email for an user
| email required | string new email of user |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
set an avatar image for an user
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a playqueue for calling user
| playQueueTracks | boolean Default: false include tracks on playqueue |
| playQueueTrackIDs | boolean Default: false include track ids on playqueue |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
internal server error
create/update the playqueue for calling user
| trackIDs required | Array of string the track ids of the playqueue |
| currentID | string the track id of the current playing track |
| position | integer >= 0 the position in the current playing track |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a bookmarks list for the calling user
| bookmarkTrack | boolean Default: false include the track of the bookmark |
| trackMedia | boolean Default: false include media informations on track(s) |
| trackTag | boolean Default: false include tag on track(s) |
| trackID3 | boolean Default: false include id3 tag on track(s) |
| trackState | boolean Default: false include user states (fav,rate) on track(s) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
create a bookmark
| trackID | string a track id |
| comment | string a comment |
| position required | integer >= 0 the position of the bookmark (in ms) |
ok
parameter is missing or invalid
unauthorized
internal server error
delete a bookmark
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get a root by id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get roots by ids
| ids required | Array of string array of item ids |
ok
parameter is missing or invalid
unauthorized
internal server error
search roots
| offset | integer >= 0 Default: 0 get back items from position |
| amount | integer >= 1 get back number of items |
| query | string search query |
| sortField | string the obj property name to sort on (e.g. 'artist', 'creation') |
| sortDescending | boolean Default: false the sort direction |
ok
parameter is missing or invalid
unauthorized
internal server error
start a root scan by root id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
scanning status of a root scan by root id
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
internal server error
download default image as binary
| format | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| name required | string name of the root |
| path required | string absolute path of the root |
| strategy required | string (Jam.RootScanStrategy) Enum:"artistalbum" "audiobook" "auto" "compilation" |
ok
parameter is missing or invalid
unauthorized
internal server error
| name required | string name of the root |
| path required | string absolute path of the root |
| strategy required | string (Jam.RootScanStrategy) Enum:"artistalbum" "audiobook" "auto" "compilation" |
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
| id required | string the item id |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get admin settings for the server
ok
unauthorized
internal server error
| chat required | object (Jam.AdminSettingsChat) |
| index required | object (Jam.AdminSettingsIndex) |
| library required | object (Jam.AdminSettingsLibrary) |
ok
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download image for object as binary by id
| format required | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| size required | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download image for object as binary by id
| size required | integer [ 16 .. 1024 ] size of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download image for object as binary by id
| format required | string Default: "png" Enum:"bmp" "jpeg" "jpg" "png" "tiff" format of the image |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download image for object as binary by id
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
stream a media file in a format
| format required | string Default: "mp3" Value:"mp3" format of audio stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
stream a media file
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
get peaks waveform data as svg | json | binary
| format required | string Default: "svg" Enum:"dat" "json" "svg" format of waveform data |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download object as binary archive by id
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error
download object as binary archive by id
| format required | string Default: "zip" Enum:"tar" "zip" format of download stream |
| id required | string the item id |
binary data
parameter is missing or invalid
unauthorized
requested object not found
internal server error